<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1-20130512"/>
<title>3D Cell: Polygon Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">3D Cell
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1-20130512 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_polygon-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Polygon Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A polygon class.  
 <a href="class_polygon.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="csg__type_8h_source.html">csg_type.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a00b81f3923cfaf3b3926dd20c6ad3f2d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a00b81f3923cfaf3b3926dd20c6ad3f2d">Polygon</a> (vector&lt; <a class="el" href="class_vertex3.html">Vertex3</a> &gt; _vertices, double _share)</td></tr>
<tr class="memdesc:a00b81f3923cfaf3b3926dd20c6ad3f2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor.  <a href="#a00b81f3923cfaf3b3926dd20c6ad3f2d">More...</a><br/></td></tr>
<tr class="separator:a00b81f3923cfaf3b3926dd20c6ad3f2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c548114d310c23d2c2218d3a0928bd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_polygon.html">Polygon</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a9c548114d310c23d2c2218d3a0928bd0">clone</a> ()</td></tr>
<tr class="memdesc:a9c548114d310c23d2c2218d3a0928bd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone a new polygon from this polygon.  <a href="#a9c548114d310c23d2c2218d3a0928bd0">More...</a><br/></td></tr>
<tr class="separator:a9c548114d310c23d2c2218d3a0928bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3be1dc4b49219ee8143f832d7be7d2eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a3be1dc4b49219ee8143f832d7be7d2eb">invert</a> ()</td></tr>
<tr class="memdesc:a3be1dc4b49219ee8143f832d7be7d2eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert the polygon.  <a href="#a3be1dc4b49219ee8143f832d7be7d2eb">More...</a><br/></td></tr>
<tr class="separator:a3be1dc4b49219ee8143f832d7be7d2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04cbe1a6496deff37f20a4bfe3d10ef2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a04cbe1a6496deff37f20a4bfe3d10ef2">update</a> ()</td></tr>
<tr class="memdesc:a04cbe1a6496deff37f20a4bfe3d10ef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update polygon's AABB and plane after transform.  <a href="#a04cbe1a6496deff37f20a4bfe3d10ef2">More...</a><br/></td></tr>
<tr class="separator:a04cbe1a6496deff37f20a4bfe3d10ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab181145fd40161a12a7d1a71d4a0e58c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector3.html">Vector3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#ab181145fd40161a12a7d1a71d4a0e58c">normal</a></td></tr>
<tr class="memdesc:ab181145fd40161a12a7d1a71d4a0e58c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The normal of the polygon.  <a href="#ab181145fd40161a12a7d1a71d4a0e58c">More...</a><br/></td></tr>
<tr class="separator:ab181145fd40161a12a7d1a71d4a0e58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8222c768a4cd6880d09db9a35bf04a7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_a_a_b_b_box.html">AABBBox</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a8222c768a4cd6880d09db9a35bf04a7a">box</a></td></tr>
<tr class="memdesc:a8222c768a4cd6880d09db9a35bf04a7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bounding box of this polygon.  <a href="#a8222c768a4cd6880d09db9a35bf04a7a">More...</a><br/></td></tr>
<tr class="separator:a8222c768a4cd6880d09db9a35bf04a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac84f9bda112c92dbb95ca05c4e1bd85d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#ac84f9bda112c92dbb95ca05c4e1bd85d">w</a></td></tr>
<tr class="memdesc:ac84f9bda112c92dbb95ca05c4e1bd85d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The plane position of the polygon in plane function ax+by+cz+w=0.  <a href="#ac84f9bda112c92dbb95ca05c4e1bd85d">More...</a><br/></td></tr>
<tr class="separator:ac84f9bda112c92dbb95ca05c4e1bd85d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228f26894205279554fcc580a4aa84ac"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a228f26894205279554fcc580a4aa84ac">share</a></td></tr>
<tr class="memdesc:a228f26894205279554fcc580a4aa84ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">All polygons that are clones of each other or were split from the same polygon will have the same share value.  <a href="#a228f26894205279554fcc580a4aa84ac">More...</a><br/></td></tr>
<tr class="separator:a228f26894205279554fcc580a4aa84ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a231e83f1fd937c8ff35e1965aeda53a6"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="class_vertex3.html">Vertex3</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_polygon.html#a231e83f1fd937c8ff35e1965aeda53a6">vertices</a></td></tr>
<tr class="memdesc:a231e83f1fd937c8ff35e1965aeda53a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">All the vertices which represnet this polygon. The vertices in a polygon must be coplanar and form a convex loop.  <a href="#a231e83f1fd937c8ff35e1965aeda53a6">More...</a><br/></td></tr>
<tr class="separator:a231e83f1fd937c8ff35e1965aeda53a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A polygon class. </p>
<p>Represents a convex polygon. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a00b81f3923cfaf3b3926dd20c6ad3f2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Polygon::Polygon </td>
          <td>(</td>
          <td class="paramtype">vector&lt; <a class="el" href="class_vertex3.html">Vertex3</a> &gt;&#160;</td>
          <td class="paramname"><em>_vertices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>_share</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_vertices</td><td>all the vertices stored in a std::vector. </td></tr>
    <tr><td class="paramname">_share</td><td>the share property. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9c548114d310c23d2c2218d3a0928bd0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_polygon.html">Polygon</a> * Polygon::clone </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clone a new polygon from this polygon. </p>

</div>
</div>
<a class="anchor" id="a3be1dc4b49219ee8143f832d7be7d2eb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Polygon::invert </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Invert the polygon. </p>

</div>
</div>
<a class="anchor" id="a04cbe1a6496deff37f20a4bfe3d10ef2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Polygon::update </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Update polygon's AABB and plane after transform. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8222c768a4cd6880d09db9a35bf04a7a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_a_a_b_b_box.html">AABBBox</a> Polygon::box</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The bounding box of this polygon. </p>

</div>
</div>
<a class="anchor" id="ab181145fd40161a12a7d1a71d4a0e58c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vector3.html">Vector3</a> Polygon::normal</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The normal of the polygon. </p>

</div>
</div>
<a class="anchor" id="a228f26894205279554fcc580a4aa84ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double Polygon::share</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All polygons that are clones of each other or were split from the same polygon will have the same share value. </p>

</div>
</div>
<a class="anchor" id="a231e83f1fd937c8ff35e1965aeda53a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt;<a class="el" href="class_vertex3.html">Vertex3</a>&gt; Polygon::vertices</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>All the vertices which represnet this polygon. The vertices in a polygon must be coplanar and form a convex loop. </p>

</div>
</div>
<a class="anchor" id="ac84f9bda112c92dbb95ca05c4e1bd85d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double Polygon::w</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The plane position of the polygon in plane function ax+by+cz+w=0. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="csg__type_8h_source.html">csg_type.h</a></li>
<li><a class="el" href="csg__type_8cpp.html">csg_type.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 10 2013 15:09:09 for 3D Cell by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1-20130512
</small></address>
</body>
</html>
